创建有效期动态 PIX QR 码

有效期动态 QR 码适用于发起方已知且希望便利支付的场景，可添加截止日期、折扣、罚款和利息。此类 QR 码通常用于替代银行条形码（boleto bancário）。

请求

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/qrcode

MÉTODO

POST

请求体：有效期动态 QR 码

{
  "request_control_key": "8a923886-afce-4116-ac1f-69bdffcf8da9",
  "qr_code_type": "dynamic_term",
  "amount": 10.25,
  "receiver_conciliation_id": "01GVGV9NXBCY287Z6CJ4S0ENW9",
  "payer_document_number": "00000000000000",
  "payer_name": "Random",
  "payer_request": "Payment for order XXXXXXXXXX",
  "pix_key": "3d7d6a2b-f72f-44c7-bb20-79a94dff5954",
  "expiration_date": "2023-03-25",
  "max_payment_days": 128,
  "fine_amount": 3,
  "interest_amount": 2,
  "rebate_amount": 1,
  "discounts": [],
  "additional_data": [
    {
      "key_name": "merchant_name",
      "value": "Lojas Costa S.A."
    }
  ],
}

请求体参数

字段	类型	描述	字符数
`request_control_key` *	string	请求的唯一 UUID4 标识符。	-
`qr_code_type` *	string	动态 QR 码类型。	"dynamic_term" 或 "dynamic_instant"
`amount` *	float	QR 码在计算折扣或利息罚款前的金额。	-
`receiver_conciliation_id` *	string	支付后用于对账的 QR 码标识符。	-
`payer_document_number` *	string	付款方 CPF/CNPJ。	-
`payer_name` *	string	付款方姓名。	-
`payer_request` *	string	给付款方的消息。	-
`pix_key` *	string	代表交易目标账户的 PIX 密钥。	-
`expiration_date` *	date	账单到期日（格式 "YYYY-MM-DD"）。	-
`max_payment_days` *	int32	账单到期后的最长付款天数。	-
`fine_amount` *	float	到期后的绝对罚款金额。	-
`interest_amount` *	float	到期后每天逾期的绝对利息金额，若在到期后一天支付，总金额为原始金额加罚款。	-
`rebate_amount` *	float	支付前的绝对折扣金额。	-
`discounts`	array of objects	折扣配置。	-
`additional_data`	array of objects	QR 码的额外信息，用于对账。	-

additional_data 对象

字段	类型	描述	字符数
`key_name` *	string	字段名称。	-
`value` *	string	字段值。	-

discount 对象

字段	类型	描述	字符数
`discount_value` *	float	折扣金额。	-
`discount_number`	int32	折扣应用的顺序。	-
`discount_limit_date` *	string	折扣截止日期。	-

响应

STATUS

201 Created

响应体：创建有效期动态 QR 码

{
  "request_control_key": "037b46b1-0c67-4c0d-aac3-1e395dfdcb10",
  "qr_code_key": "d74bf12a-9243-4bfa-9b00-6b63755b6555",
  "qr_code_status": "active",
  "base_64_payload": "<BASE64 DA URI DO PIX COPIA E COLA>",
  "created_at": "2023-03-03T12:04:06.179Z",
}

字段	类型	描述	字符数
`request_control_key` *	string	请求的唯一 UUID4 标识符。	-
`qr_code_key` *	string	用于后续请求的 QR 码标识符。	-
`qr_code_status` *	string	系统中的 QR 码状态。	"active"：创建时的默认值。
`base_64_payload` *	string	Base64 格式的 QR 码支付 URL。	-
`created_at` *	datetime	QR 码在系统中的创建日期和时间。	-

qr_code_status 对象

字段	类型	描述	字符数
`active`	string	QR 码处于活跃状态，可用于支付。	-
`finished`	string	QR 码已支付。	-
`written_off`	string	QR 码已被客户撤销。	-
`bank_written_off`	string	QR 码因期限过期被自动撤销。	-

STATUS

400

响应体

{
    "title": "Bad Request",
    "description": "Invalid payload for QR Code creation.",
    "translation": "Payload inválido para a criação de QR Code.",
    "code": "QRI000003"
}

请求​

请求体参数​

additional_data 对象​

discount 对象​

响应​

qr_code_status 对象​

请求

请求体参数

additional_data 对象

discount 对象

响应

qr_code_status 对象